home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Vollversion / CamD / development / docs / camdlist.doc < prev    next >
Text File  |  2000-05-15  |  9KB  |  258 lines
  1. TABLE OF CONTENTS
  2.  
  3. camdlists.lib/AllocListRequest
  4. camdlists.lib/FreeListRequest
  5. camdlists.lib/ListRequest
  6. camdlists.lib/SelectCluster
  7. camdlists.lib/SelectConductor
  8. camdlists.lib/AllocListRequest                 camdlists.lib/AllocListRequest
  9.  
  10.    NAME
  11.        AllocListRequest -- allocate a scrolling list requester
  12.  
  13.    SYNOPSIS
  14.        list = AllocListRequest( firsttag )
  15.  
  16.         void *AllocListRequest( Tag, ... );
  17.  
  18.        list = AllocListRequestA( taglist )
  19.  
  20.         void *AllocListRequestA( struct TagItem * );
  21.  
  22.    FUNCTION
  23.        This function allocates a list requester structure and fills it in
  24.        using the supplied tag list.
  25.  
  26.    INPUTS
  27.         The following is a list of tags recognized. Note that since the
  28.         functionality of the list requester is very similar to the ASL
  29.         requesters, the actual ASL tag values have been used, and the
  30.         listrequester tags have been defined in terms of the ASL values.
  31.  
  32.         These tags have the exact same meaning as the corresponding ASL tag:
  33.  
  34.             LISTREQ_Window                   ASLFR_Window
  35.             LISTREQ_Screen                   ASLFR_Screen
  36.             LISTREQ_UserData               ASLFR_UserData
  37.             LISTREQ_TitleText              ASLFR_TitleText
  38.             LISTREQ_PositiveText           ASLFR_PositiveText
  39.             LISTREQ_NegativeText           ASLFR_NegativeText
  40.             LISTREQ_InitialLeftEdge        ASLFR_InitialLeftEdge
  41.             LISTREQ_InitialTopEdge         ASLFR_InitialTopEdge
  42.             LISTREQ_InitialWidth          ASLFR_InitialWidth
  43.             LISTREQ_InitialHeight          ASLFR_InitialHeight
  44.             LISTREQ_HookFunc             ASLFR_HookFunc
  45.  
  46.         These additional tags are defined
  47.  
  48.             LISTREQ_Labels - pointer to struct List of labels to display.
  49.  
  50.             LISTREQ_Selected - The number of the selected list element.
  51.  
  52.             LISTREQ_Buffer - an optional pointer to a character buffer.
  53.                 Supplying this tag will cause a string gadget to appear
  54.                 below the list, where the user can type the name of an
  55.                 element not in the list. In addition, clicking on a
  56.                 list element will copy that element's text into the
  57.                 buffer, overwriting the string. When the requester
  58.                 terminates, the contents of the string gadget will be copied
  59.                 to the buffer.
  60.  
  61.                 In addition, this buffer can be filled in by the application
  62.                 before calling this function to initialize the string gadget.
  63.  
  64.             LISTREQ_BufferSize - size of the supplied buffer.
  65.  
  66.         These tags have been defined but not yet implemented:
  67.  
  68.             LISTREQ_PubScreenName          ASLFR_PubScreenName
  69.             LISTREQ_PrivateIDCMP           ASLFR_PrivateIDCMP
  70.             LISTREQ_IntuiMsgFunc           ASLFR_IntuiMsgFunc
  71.             LISTREQ_SleepWindow            ASLFR_SleepWindow
  72.             LISTREQ_TextAttr               ASLFR_TextAttr
  73.             LISTREQ_Locale                   ASLFR_Locale
  74.  
  75.  
  76.    RESULT
  77.       list     -- a pointer to a list request.
  78.  
  79.    EXAMPLE
  80.  
  81.    NOTES
  82.  
  83.    BUGS
  84.  
  85.    SEE ALSO
  86.        ListRequest(), FreeListRequest()
  87.  
  88. camdlists.lib/FreeListRequest                   camdlists.lib/FreeListRequest
  89.  
  90.    NAME
  91.        FreeListRequest -- display a scrolling list requester
  92.  
  93.    SYNOPSIS
  94.        FreeListRequest( listreq )
  95.  
  96.         FreeListRequest( void * );
  97.  
  98.    FUNCTION
  99.        This function deallocates the list requester previously created by
  100.        AllocListRequest
  101.  
  102.    INPUTS
  103.         listreq -- pointer to a previously allocated list requester
  104.  
  105.    RESULT
  106.  
  107.    EXAMPLE
  108.  
  109.    NOTES
  110.  
  111.    BUGS
  112.  
  113.    SEE ALSO
  114.        AllocListRequest(), ListRequest()
  115.  
  116. camdlists.lib/ListRequest                           camdlists.lib/ListRequest
  117.  
  118.    NAME
  119.        ListRequest -- display a scrolling list requester
  120.  
  121.    SYNOPSIS
  122.        confirm = ListRequest( listreq, firsttag )
  123.  
  124.         LONG ListRequest( void *, Tag, ... );
  125.  
  126.        confirm = ListRequestA( listreq, taglist )
  127.  
  128.         LONG ListRequestA( void *, struct TagItem * );
  129.  
  130.    FUNCTION
  131.        This function displays the list requester previously created by
  132.        AllocListRequest
  133.  
  134.    INPUTS
  135.         listreq -- pointer to a previously allocated list requester
  136.         tags -- the same tags values as AllocListRequest
  137.  
  138.    RESULT
  139.           confirm -- returns TRUE if the positive choice button was clicked,
  140.         or a list entry was double-clicked, returns FALSE if the negative
  141.         choice button was clicked.
  142.  
  143.    EXAMPLE
  144.  
  145.    NOTES
  146.  
  147.    BUGS
  148.  
  149.    SEE ALSO
  150.        AllocListRequest(), FreeListRequest()
  151.  
  152. camdlists.lib/SelectCluster                       camdlists.lib/SelectCluster
  153.  
  154.    NAME
  155.        SelectCluster -- graphically select a MIDI cluster by name
  156.  
  157.    SYNOPSIS
  158.         confirm = SelectCluster( listreq, buffer, maxlength, taglist );
  159.  
  160.        LONG SelectCluster( void *, char *, LONG, Tag, ... );
  161.  
  162.    FUNCTION
  163.        This function presents the user with a list of all active
  164.        clusters in camd.library. The user can click on an existing
  165.         cluster, or type in the name of a new cluster into the
  166.         supplied string gadget. "Select" and "Cancel" buttons are also
  167.         supplied.
  168.  
  169.    INPUTS
  170.         listreq -- pointer to a previously allocated list requester
  171.         buffer -- where to put the name the user typed or selected.
  172.             In addition, this should be filled in with the name of
  173.             the existing cluster.
  174.         maxlength -- the length of the buffer.
  175.         tags -- the same tags values as AllocListRequest
  176.  
  177.         These LISTREQ tags are passed through to the List Requester:
  178.  
  179.             LISTREQ_Window                   ASLFR_Window
  180.             LISTREQ_Screen                   ASLFR_Screen
  181.             LISTREQ_UserData               ASLFR_UserData
  182.             LISTREQ_TitleText              ASLFR_TitleText
  183.             LISTREQ_PositiveText           ASLFR_PositiveText
  184.             LISTREQ_NegativeText           ASLFR_NegativeText
  185.             LISTREQ_InitialLeftEdge        ASLFR_InitialLeftEdge
  186.             LISTREQ_InitialTopEdge         ASLFR_InitialTopEdge
  187.             LISTREQ_InitialWidth          ASLFR_InitialWidth
  188.             LISTREQ_InitialHeight          ASLFR_InitialHeight
  189.             LISTREQ_HookFunc             ASLFR_HookFunc
  190.  
  191.    RESULT
  192.           confirm -- returns TRUE if the positive choice button was clicked,
  193.         or a list entry was double-clicked. Returns FALSE if the negative
  194.         choice button was clicked.
  195.  
  196.    EXAMPLE
  197.  
  198.    NOTES
  199.  
  200.    BUGS
  201.  
  202.    SEE ALSO
  203.        AllocListRequest(), ListRequest(), FreeListRequest()
  204.  
  205. camdlists.lib/SelectConductor                   camdlists.lib/SelectConductor
  206.  
  207.    NAME
  208.        SelectConductor -- graphically select a conductor by name
  209.  
  210.    SYNOPSIS
  211.         confirm = SelectConductor( listreq, buffer, maxlength, taglist );
  212.  
  213.        LONG SelectConductor( void *, char *, LONG, Tag, ... );
  214.  
  215.    FUNCTION
  216.        This function presents the user with a list of all active
  217.        conductors in realtime.library. The user can click on an existing
  218.         conductor, or type in the name of a new conductor into the
  219.         supplied string gadget. "Select" and "Cancel" buttons are also
  220.         supplied.
  221.  
  222.    INPUTS
  223.         listreq -- pointer to a previously allocated list requester
  224.         buffer -- where to put the name the user typed or selected.
  225.             In addition, this should be filled in with the name of
  226.             the existing conductor.
  227.         maxlength -- the length of the buffer.
  228.         tags -- the same tags values as AllocListRequest
  229.  
  230.         These LISTREQ tags are passed through to the List Requester:
  231.  
  232.             LISTREQ_Window                   ASLFR_Window
  233.             LISTREQ_Screen                   ASLFR_Screen
  234.             LISTREQ_UserData               ASLFR_UserData
  235.             LISTREQ_TitleText              ASLFR_TitleText
  236.             LISTREQ_PositiveText           ASLFR_PositiveText
  237.             LISTREQ_NegativeText           ASLFR_NegativeText
  238.             LISTREQ_InitialLeftEdge        ASLFR_InitialLeftEdge
  239.             LISTREQ_InitialTopEdge         ASLFR_InitialTopEdge
  240.             LISTREQ_InitialWidth          ASLFR_InitialWidth
  241.             LISTREQ_InitialHeight          ASLFR_InitialHeight
  242.             LISTREQ_HookFunc             ASLFR_HookFunc
  243.  
  244.    RESULT
  245.           confirm -- returns TRUE if the positive choice button was clicked,
  246.         or a list entry was double-clicked. Returns FALSE if the negative
  247.         choice button was clicked.
  248.  
  249.    EXAMPLE
  250.  
  251.    NOTES
  252.  
  253.    BUGS
  254.  
  255.    SEE ALSO
  256.        AllocListRequest(), ListRequest(), FreeListRequest()
  257.  
  258.